Lookup Account
GET /api/v1/accounts/{accountIdOrNumber}/lookup
Description
Lookup account details using the account ID or number.
Path Parameters
| Name | Type | Description |
|---|---|---|
accountIdOrNumber | string | The account ID or number (path) |
Query Parameters
| Name | Type | Description |
|---|---|---|
accountTenantIds | string | Tenant IDs separated by commas (query) |
Example
GET /api/v1/accounts/123456/lookup?accountTenantIds=tenant1,tenant2
Content-Type: application/json
Response Code: 200 - OK
Description
Successful response with account details.
Example
{
"accountIdOrNumber": "123456",
"tenantIds": ["tenant1", "tenant2"],
"accountDetails": {
// account details here
}
}
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
Query Parameters
| Param | Value |
|---|---|
| accountTenantIds | tenant1,tenant2 |
###🔑 Authentication bearer
| Param | Value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request GET \
--url /api/v1/accounts/{accountIdOrNumber}/lookup \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!